prompt-choices

prompt-choices

Create an array of multiple choice objects for use in prompts.

Install

Install with npm:

$ npm install --save prompt-choices

Install with yarn:

$ yarn add prompt-choices

Usage

var Choices = require('prompt-choices');
var choices = new Choices(['foo', 'bar', 'baz']);

API

Choices

Create a new Choices collection.

Params

• choices {Array}: One or more choice strings or objects.

Example

var choices = new Choices(['foo', 'bar', 'baz']);
var choices = new Choices([{name: 'foo'}, {name: 'bar'}, {name: 'baz'}]);

.render

Render the current choices.

Params

• position {Number}: Cursor position
• options {Object}
• returns {String}

.addChoices

Add an array of normalized choice objects to the choices array. This method is called in the constructor, but it can also be used to add choices after instantiation.

Params

• choices {Array|Object}: One or more choices to add.

Example

choices.addChoices(['a', 'b', 'c']);

.choice

Create a new Choice object.

Params

• choice {String|Object}
• returns {Object}: Returns a choice object.

Example

choices.choice('blue');

.separator

Create a new Separator object. See choices-separator for more details.

Params

• separator {String}: Optionally pass a string to use as the separator.
• returns {Object}: Returns a separator object.

Example

choices.separator();

.hasChoice

Returns true if a choice exists.

Params

• val {Number}: The index or key of the choice to check for.
• returns {Boolean}

Example

choices.hasChoice(1);
choices.hasChoice('foo');

.get

Get the choice or separator object at the specified index.

Params

• idx {Number}: The index of the object to get
• returns {Object}: Returns the specified choice

Example

var choice = choices.get(1);

.getChoice

Get a non-separator choice from the collection.

Params

• idx {Number}: The selected choice index
• returns {Object|undefined}: Return the matched choice object or undefined

Example

choices.getChoice(1);
choices.getChoice('foo');

.getIndex

Get the index of a non-separator choice from the collection.

Params

• key {String}: The key of the choice to get
• returns {Number}: Index of the choice or -1;

Example

var choices = new Choices(['foo', 'bar', 'baz']);
console.log(choices.getIndex('foo')); //=> 0
console.log(choices.getIndex('baz')); //=> 2
console.log(choices.getIndex('bar')); //=> 1
console.log(choices.getIndex('qux')); //=> -1

.enable

Enable the choice at the given idx.

Params

• idx {Number}: The index of the choice to enable.

Example

choices.enable(1);

.disable

Disable the choice at the given idx.

Params

• idx {Number}: The index of the choice to enable.

Example

choices.disable(1);

.toggle

Toggle the choice at the given idx.

Params

• idx {Number}: The index of the choice to toggle.

Example

choices.toggle(1);
// radio mode
choices.toggle(1, true);

.where

Return choice values for choices that return truthy based on the given val.

Params

• val {Object|Function|String|RegExp}
• returns {Array}: Matching choices or empty array

.isValidIndex

Returns true if the given index is a valid choice index.

Params

• key {String}: Property name to use for plucking objects.
• returns {Array}: Plucked objects

.key

Return the .key property from the choice at the given index.

Params

• key {String}: Property name to use for plucking objects.
• returns {Array}: Plucked objects

.pluck

Pluck an object with the specified key from the choices collection.

Params

• key {String}: Property name to use for plucking objects.
• returns {Array}: Plucked objects

.checked

Getter for getting the checked choices from the collection.

.length

Getter for getting the length of the collection.

.Separator

Create a new Separator object. See choices-separator for more details.

Params

• separator {String}: Optionally pass a string to use as the separator.
• returns {Object}: Returns a separator object.

Example

new Choices.Separator();

Attribution

Code is partially based on the Choices class in Inquirer.

About

Related projects

• enquirer: Intuitive, plugin-based prompt system for node.js. Much faster and lighter alternative to Inquirer, with all… more | homepage
• prompt-base: Base prompt module used for creating custom prompt types for Enquirer. | homepage
• prompt-checkbox: Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like [Enquirer]. | homepage
• prompt-question: Question object, used by Enquirer and prompt plugins. | homepage
• prompt-radio: Radio prompt. This prompt behaves like other radio-button interfaces, where only one choice is enabled… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on April 29, 2017.